/*
 * Copyright (c) 2010, Oracle
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 *  * Redistributions of source code must retain the above copyright notice, 
 *    this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright 
 *    notice, this list of conditions and the following disclaimer in 
 *    the documentation and/or other materials provided with the distribution.
 *  * Neither the name of Oracle nor the names of its 
 *    contributors may be used to endorse or promote products derived 
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */
 
package org.netbeans.javafx.datasrc;

import org.netbeans.javafx.datasrc.MemoryRecordSet;

/**
 * A parser that converts stream of data to a RecordSet.
 *
 * @author Maros Sandor
 */
public abstract class StreamParser {

    /**
     * A parser that converts stream of data to a RecordSet.
     *
     * @param input an input stream of data
     * @param recordDisplayName a function to inject into all generated Records, see DataSource for more information
     * @return RecordSet generated RecordSet by parsing input data
     */
    public function parse(reader : java.io.Reader) : RecordSet {
        MemoryRecordSet {
            records: []
        }
    }

    /**
     * Converts stream of data to a RecordSet. The default implementation just calls the other parse method that
     * takes a Reader using UTF-8 incoding.
     *
     * @param input an input stream of data
     * @param recordDisplayName a function to inject into all generated Records, see DataSource for more information
     * @return RecordSet generated RecordSet by parsing input data
     */
    public function parse(input : java.io.InputStream) : RecordSet {
        parse(new java.io.InputStreamReader(input, "UTF-8"))
    }
}
